Refresh README: fix stale versions, links, and Travis references#35
Open
tas50 wants to merge 1 commit into
Open
Refresh README: fix stale versions, links, and Travis references#35tas50 wants to merge 1 commit into
tas50 wants to merge 1 commit into
Conversation
Bring the README in line with the current project state: - Update the supported-versions note from "Ruby 2.5 / Chef 15" to "Ruby 3.1 / Chef 17" to match the gemspec's required_ruby_version and chef dependency. - Replace Travis CI references with GitHub Actions, including the broken `[travis]` reference link that had no definition. - Fix the CI badge and all repo links from the old chefspec/chefspec org to chef/chefspec. - Remove the empty "Quick Start" heading. - Point the RSpec Mocks link at rspec.info instead of the retired relishapp.com. Signed-off-by: Tim Smith <tsmith84@proton.me>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the README in line with the current state of the project. This fixes recommendation #3 from the earlier modernization review (the README contradicted the gemspec and still referenced Travis) plus a few related cleanups.
Changes
required_ruby_versionand thechefdependency inchefspec.gemspec.[Travis CI][travis]reference-style link whose[travis]:definition didn't exist, so it was rendering as broken literal text.chefspec/chefspecorg tochef/chefspec(the badge was pointing at a non-existent workflow and showing as broken).## Quick Startheading (it had no content; the following "When To Use" / custom-resource walkthrough already serves as the getting-started material).relishapp.comtorspec.info.